Skip to content

[ENH]: SysDb should return lineage, version file paths and root collection ID on collections #4557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

codetheweb
Copy link
Contributor

@codetheweb codetheweb commented May 15, 2025

Description of changes

See title. Needed for garbage collector tests.

Test plan

How are these changes tested?

Updated existing Go tests to cover changes on Go side. Rust changes will be consumed in a future PR.

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs section?

n/a

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@codetheweb codetheweb marked this pull request as ready for review May 15, 2025 20:05
Copy link
Contributor

propel-code-bot bot commented May 15, 2025

Expose Lineage, Version File Paths, and Root Collection ID in SysDb Collection Metadata

This PR extends SysDb's collection representation, plumbing metadata fields version_file_path, lineage_file_path, and root_collection_id through the API, protobuf types, database models, and associated tests for both Rust and Go. The changes are mainly required for garbage collector testing and better handling of collection versioning and ancestry.

Key Changes:
• Protobuf definition in chroma.proto updated: Collection now includes optional version_file_path, root_collection_id, and lineage_file_path.
• Go and Rust collection models, database models, and mock interfaces updated to store and propagate new fields (now using pointer semantics for nullability).
• Collection conversion/mapping logic across system layers (Go/Rust/DB) was adapted to correctly marshal/unmarshal these new fields.
• Significant tests in both Go and Rust updated or extended to validate new metadata fields are handled correctly, especially around collection creation, GC, and forks.

Affected Areas:
• Protobuf API (chroma.proto)
• SysDb internals and interfaces (Rust and Go)
• Collection model/database schema and read/write paths
• Testing infrastructure for collection metadata and GC

This summary was automatically generated by @propel-code-bot

Copy link
Contributor Author

@codetheweb codetheweb force-pushed the feat-return-collection-with-version-file-lineage-file-root-collection-2 branch from 8a3421d to 972427e Compare May 15, 2025 23:34
@codetheweb codetheweb force-pushed the feat-return-collection-with-version-file-lineage-file-root-collection-2 branch from 972427e to bab5b68 Compare May 19, 2025 23:38
@codetheweb codetheweb force-pushed the feat-return-collection-with-version-file-lineage-file-root-collection-2 branch from bab5b68 to 5f7fa4a Compare May 20, 2025 18:02
@codetheweb codetheweb merged commit 71c953d into main May 20, 2025
71 checks passed
Copy link
Contributor Author

Merge activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants